
## Game installation and updating

Pick an application from the list below that suits your preferences.
Each of them is capable of installing and updating the game. Additional features
such as automated patching might or might not be included.

 * The official launcher (recommended)
     * Note: Wine 8.7 or newer should be used to avoid a memory leak in `winedevice.exe`
     * See [INSTALLATION.md](../INSTALLATION.md) for further instructions.
 * [An Anime Game Launcher](https://github.com/an-anime-team/an-anime-game-launcher)
 * [Yet another anime game launcher](https://github.com/3Shain/yet-another-anime-game-launcher) (macOS)
 * `updater.py` (CLI only, described below)

---

## Update script (sophon chunk/diff)

## Setup

### 1. Python requirements

Python 3.8 or newer is required (`zstandard` library)

    pip install -r requirements.txt

### 2. Generate `manifest_pb2.py`

1. Required system package
	* Ubuntu/Debian: protobuf-compiler
2. Generate
	* `$ protoc --python_out=. manifest.proto`
	* `$ protoc --python_out=. manifest_ldiff.proto`


## Usage

**Show command-line options / help dialogue**

    python updater.py -h

**Game update** (example)

	python updater.py --update /install/destination/path

**New game install** (example)

	python updater.py --install RELTYPE --select-languages "en,ja,ko,zh" /install/destination/path

**Game repair** (example)

	python updater.py --repair reliable /install/destination/path

For development purposes:

	python updater.py <install/update> --dry-run --disallow-download

## Developer notes

See `sophon_api.py` heading
